Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add missed documentation for CA's options. #41001

Merged
merged 10 commits into from
Jun 4, 2024
Merged

Add missed documentation for CA's options. #41001

merged 10 commits into from
Jun 4, 2024

Conversation

FrediKats
Copy link
Contributor

@FrediKats FrediKats commented May 18, 2024 •
edited by github-actions bot
Loading

Summary

File code-quality-rule-options does not contain all options of CA rules. I found that https://github.com/dotnet/roslyn-analyzers/blob/main/docs/Analyzer%20Configuration.md describes more options. I add missed part to this repo because documentation for all other rules located here.

Internal previews

📄 File 🔗 Preview link
docs/fundamentals/code-analysis/code-quality-rule-options.md Code quality rule configuration options

@FrediKats FrediKats requested a review from gewarren as a code owner May 18, 2024 09:24
@dotnet-bot dotnet-bot added this to the May 2024 milestone May 18, 2024
@dotnet-policy-service dotnet-policy-service bot added the community-contribution Indicates PR is created by someone from the .NET community. label May 18, 2024
@FrediKats
Copy link
Contributor Author

I rechecked usages of sufficient_IterationCount_for_weak_KDF_algorithm and unsafe_DllImportSearchPath_bits and don't understand what wrong.

@gewarren, can you help with this?

Error:

Error: In file 'docs/fundamentals/code-analysis/code-quality-rule-options.md': Invalid link: '#unsafe_DllImportSearchPath_bits'.
Error: In file 'docs/fundamentals/code-analysis/code-quality-rule-options.md': Invalid link: '#sufficient_IterationCount_for_weak_KDF_algorithm'.

File content:

- [unsafe_DllImportSearchPath_bits](#unsafe_DllImportSearchPath_bits)
- [sufficient_IterationCount_for_weak_KDF_algorithm](#sufficient_IterationCount_for_weak_KDF_algorithm)

...

### unsafe_DllImportSearchPath_bits
### sufficient_IterationCount_for_weak_KDF_algorithm

@gewarren
Copy link
Contributor

I rechecked usages of sufficient_IterationCount_for_weak_KDF_algorithm and unsafe_DllImportSearchPath_bits and don't understand what wrong.

@gewarren, can you help with this?

@FrediKats I'm pretty sure the bookmark links to those sections need to use lower case letters only.

@FrediKats
Copy link
Contributor Author

@gewarren, thanks!

gewarren
gewarren requested changes May 20, 2024
View reviewed changes
Copy link
Contributor

@gewarren gewarren left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@FrediKats A little more feedback, but again, thanks for adding these.

docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
docs/fundamentals/code-analysis/code-quality-rule-options.md Outdated Show resolved Hide resolved
@gewarren gewarren mentioned this pull request May 20, 2024
Open
FrediKats and others added 3 commits May 21, 2024 23:03
@FrediKats
Copy link
Contributor Author

@gewarren , you removed some backslash in your suggestions. But this broke md.

Before:
image

After:
image

Markdown parse | as column separator even when this symbol located in code block.

@FrediKats FrediKats requested a review from gewarren May 22, 2024 07:53
@gewarren
Copy link
Contributor

@FrediKats Were you previewing the file in GitHub? Not escaping the pipe character might not render correctly there, but it does on learn.microsoft.com. For example:

source file
rendered page

@BillWagner BillWagner modified the milestones: May 2024, June 2024 Jun 3, 2024
@gewarren gewarren merged commit 3b51d46 into dotnet:main Jun 4, 2024
8 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gewarren gewarren gewarren approved these changes

Assignees
No one assigned
Labels
community-contribution Indicates PR is created by someone from the .NET community. dotnet-fundamentals/svc
Projects
None yet
Milestone
June 2024
Development

Successfully merging this pull request may close these issues.
4 participants
@FrediKats @gewarren @BillWagner @dotnet-bot